// 
// Entify project
//  
// Author:
//       Lauri Taimila <lauri@taimila.com>
// 
// Copyright (c) 2010 Lauri Taimila
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;

namespace Taimila.Entify.Attributes
{
	/// <summary>
	/// Defines attribute that is used to tag properties and fields of
	/// the class which is already tagged with PersistentEntity attribute.
	/// All fields and properties which are tagged with PersistentData attribute
	/// will be stored into persistent store.
	/// </summary>
	[AttributeUsage(AttributeTargets.Property)]
	public sealed class EntityPropertyAttribute: Attribute
	{
		/// <summary>
		/// Is property unique.
		/// </summary>
		public bool Unique
		{
			get;
			set;
		}
		
		/// <summary>
		/// Is property relationship to another entity.
		/// </summary>
		public bool Relationship
		{
			get;
			set;
		}

		/// <summary>
		/// Determines should marke property to be included in any persistent
		/// store index. One index is created for each index name. Multiple 
		/// properties can be grupped under one index by giving the same index 
		/// name for all of them.
		/// </summary>
		public string IndexName
		{
			get;
			set;
		}
		
		/// <summary>
		/// Name used for this property in persistent store. Differating
		/// name from property name allows renaming properies without
		/// breaking persistent store mapping.
		/// </summary>
		public string PersistentName
		{
			get;
			set;
		}
	}
}
